Skip to main content

Activity Notification

🛠️ Product Notification from Third-Party

This API is required to send notifications related to Product activities from a third party.

FieldValue
NameThirdpartyNotificationAPI
URLhttp://<domain>/v1/ThirdpartyNotificationAPI
DescriptionSend notification to end user for Product activities from third party
MethodPOST

📤 Request

Header

ParameterData TypeMandatory/OptionalDescription
AuthorizationStringMEncrypted Token; authentication token for all API calls
Content-Typeapplication/json

Body

ParameterData TypeMandatory/OptionalDescription
productCodeStringMUnique Product Code identifying the published product
typeStringM1 – Send for all products; 2 – Send for specific product
userRefIdStringMTrading User ID
messageStringMNotification text (e.g., "User has opted for Investing in EQUITYBasket")
msgSubjectStringMNotification Subject (e.g., "EQUITYBasket Investment")

Example Request

{
"productCode": "myproductCode",
"type": 2,
"userRefId": "A0001",
"message": "User has opted for Investing in EQUITYBasket",
"msgSubject": "EquityBasket Investment"
}

📄 Response

ParameterData TypeMandatory/OptionalDescription
SuccessBooleanMtrue – Success, false – Failure
DataStringMJSON string, details of order
MessageStringMSuccess/Failure message for the API
statusCodeStringMApplication status code
traceIdStringMSystem generated Code by third-party, used for VAS log purpose

** 🟢 Example Success Response**

{
"success": true,
"data": null,
"message": "Notification Send Successfully.",
"statusCode": "200",
"traceId": "2d7814b4-3d29-44cd-94f3-969e3db22eed"
}

** 🔴 Example Failure Response**

{
"success": false,
"data": null,
"message": "<respective error message>",
"statusCode": "400",
"traceId": "409dea70-df0d-4909-9321-b4f094f2ecc1"
}